libURLDownloadToFile
Type
command
Summary
Downloads a file from an Internet server asynchronously via FTP, HTTP or HTTPS
Syntax
libURLDownloadToFile <downloadURL>, <filePath> [, <callbackMessage>]
Description
Use the libURLDownloadToFile command to download a file from an FTP Server or Web Server.
The libURLDownloadToFile command transfers the data directly from the file to the server. Unlike simply using the put command to put the contents of a URL into a file, using the libURLDownloadToFile command does not load all the data into memory at once, so this command is a better choice for large files.
The libURLDownloadToFile command transfers the file in binary mode.
The callbackMessage is sent to the object whose script contains the libURLDownloadToFile command, after the download is complete, so you can handle the callbackMessage to perform any tasks you want to delay until the file has been downloaded. Two parameters are sent with the message : the URL and the URLStatus of the file.
On Mac OS and OS X systems, the new file's creator signature and type signature|file type is set to the value specified in the fileType property.
The libURLDownloadToFile command is part of the Internet library on desktop platforms. To ensure that the command works in a desktop standalone application, you must include this custom library when you create your standalone. In the Inclusions pane of the Standalone Application Settings window, make sure the "Internet" script library is selected.
On iOS and Android, libURLDownloadToFile is implemented in the engine. Therefore the Internet library is not needed to ensure the command works in a mobile standalone application. If included, the Internet library implementation will be used instead of the engine implementation.
On iOS and Android libURLDownloadToFile is blocking until the download is complete. Completion of the download is notified by the urlProgress message, where you can test if the downloaded status is set.
Parameters
| Name | Type | Description |
|---|---|---|
downloadURL | The downloadURL specifies the server and file to download, in the form of an FTP, HTTP or HTTPS url. | |
filePath | The filePath specifies the name and location to save the downloaded file in. If you specify a name but not a location, LiveCode assumes the file is in the defaultFolder. | |
callbackMessage | The name of a message to send after the download is finished. |
Examples
libURLDownloadToFile "ftp://example.org/new_beta",it
libURLDownloadToFile myFile,newPath,"downloadComplete"
Related
command: libURLSetStatusCallback, libURLFollowHttpRedirects, unload, put, load, libURLSetFTPStopTime, libURLftpUploadFile
glossary: LiveCode custom library, application, standalone application, message, property, file, Standalone Application Settings, command, main stack, OS X, type signature, group, creator signature, binary, server, download, parameter, Mac OS, handler, object
library: Internet library, library
message: urlProgress, startup, openBackground, preOpenStack, openStack, preOpenCard
Compatibility and Support
Introduced
LiveCode 2.0
OS
mac
windows
linux
ios
android
web
Platforms
desktop
server
mobile